<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Sets a function to be called at regular intervals</title>
 </head>
 <body class="docs"><div id="layout">
  <div id="layout-content"><div id="function.gupnp-context-timeout-add" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">gupnp_context_timeout_add</h1>
  <p class="verinfo">(PECL gupnp &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_context_timeout_add</span> &mdash; <span class="dc-title">Sets a function to be called at regular intervals</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.gupnp-context-timeout-add-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>gupnp_context_timeout_add</strong></span>
    ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code></span>
   , <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</code></span>
   , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$callback</code></span>
   [, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$arg</code></span>
  ] ) : <span class="type">bool</span></div>

  <p class="para rdfs-comment">
   Sets a function to be called at regular intervals.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.gupnp-context-timeout-add-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>
<code class="parameter">context</code></dt>

     <dd>

      <p class="para">
       A context identifier, returned by <span class="function"><a href="gupnp_context_new.html" class="function">gupnp_context_new()</a></span>.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">timeout</code></dt>

     <dd>

      <p class="para">
       A timeout in miliseconds.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">callback</code></dt>

     <dd>

      <p class="para">
       The callback function calling every <code class="parameter">timeout</code> period of time. 
       Typically, callback function takes on <code class="parameter">arg</code> parameter.
      </p>
     </dd>

    
    
     <dt>
<code class="parameter">arg</code></dt>

     <dd>

      <p class="para">
       User data for <code class="parameter">callback</code>.
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.gupnp-context-timeout-add-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.gupnp-context-timeout-add-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-5372">
    <p><strong>Example #1 Create new UPnP context and set callback</strong></p>
    <div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />$user_data&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">"user&nbsp;data"</span><span style="color: #007700">;<br /><br />function&nbsp;</span><span style="color: #0000BB">timeout_cb</span><span style="color: #007700">(</span><span style="color: #0000BB">$arg</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Call&nbsp;timeout_cb,&nbsp;user&nbsp;data:&nbsp;'%s'"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$arg</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;</span><span style="color: #0000BB">true</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">/*&nbsp;Create&nbsp;the&nbsp;UPnP&nbsp;context&nbsp;*/<br /></span><span style="color: #0000BB">$context&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">gupnp_context_new</span><span style="color: #007700">();<br /><br />if&nbsp;(!</span><span style="color: #0000BB">$context</span><span style="color: #007700">)&nbsp;{<br />&nbsp;die(</span><span style="color: #DD0000">"Error&nbsp;creating&nbsp;the&nbsp;GUPnP&nbsp;context\n"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/*&nbsp;Create&nbsp;root&nbsp;device&nbsp;*/<br /></span><span style="color: #0000BB">$dev&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">gupnp_root_device_new</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"/devicedesc.xml"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/*&nbsp;Set&nbsp;callback&nbsp;for&nbsp;timeout&nbsp;*/<br /></span><span style="color: #0000BB">gupnp_context_timeout_add</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">5000</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"timeout_cb"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$user_data</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/*&nbsp;Run&nbsp;the&nbsp;main&nbsp;loop&nbsp;*/<br /></span><span style="color: #0000BB">gupnp_root_device_start</span><span style="color: #007700">(</span><span style="color: #0000BB">$dev</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</pre></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.gupnp-context-timeout-add-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   Issues E_WARNING with not valid callback function. 
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.gupnp-context-timeout-add-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="gupnp_context_new.html" class="function" rel="rdfs-seeAlso">gupnp_context_new()</a> - Create a new context</span></li>
   </ul>
  </p>
 </div>


</div></div></div></body></html>